docs: don't use <option>
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 4 Feb 2014 22:48:33 +0000 (17:48 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 4 Feb 2014 22:48:33 +0000 (17:48 -0500)
gdk/gdk.c
gdk/gdkevents.c
gdk/x11/gdkmain-x11.c
gtk/deprecated/gtkrc.c
gtk/gtkmain.c

index 7ec90f7e2e8c14f3196fde1c2f287b6b8647a009..075f7c07d3766905686fc7f1e704996e3082a517 100644 (file)
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -340,7 +340,7 @@ gdk_parse_args (int    *argc,
  *
  * Gets the name of the display, which usually comes from the
  * `DISPLAY` environment variable or the
- * <option>--display</option> command line option.
+ * `--display` command line option.
  *
  * Returns: the name of the display.
  *
@@ -1098,7 +1098,7 @@ gdk_threads_add_timeout_seconds (guint       interval,
  * gdk_get_program_class:
  *
  * Gets the program class. Unless the program class has explicitly
- * been set with gdk_set_program_class() or with the <option>--class</option>
+ * been set with gdk_set_program_class() or with the `--class`
  * commandline option, the default value is the program name (determined
  * with g_get_prgname()) with the first character converted to uppercase.
  *
index a569d6d3d3a4149c1c9fc25f9ff19b260e609678..70bd6d8429bfc586020e180d51269f4f0a113aed 100644 (file)
@@ -1975,7 +1975,7 @@ gdk_event_get_event_sequence (const GdkEvent *event)
  * 
  * Sets whether a trace of received events is output.
  * Note that GTK+ must be compiled with debugging (that is,
- * configured using the <option>--enable-debug</option> option)
+ * configured using the `--enable-debug` option)
  * to use this option.
  **/
 void
index 0b4a7d6e3d86ad6728b4ab405d8a382b41bab8ad..b99e1fe2dbecc80904024b7adb9a9cb38009e8c6 100644 (file)
@@ -453,7 +453,7 @@ gdk_x11_get_default_root_xwindow (void)
  * Gets the default GTK+ display.
  * 
  * Return value: (transfer none): the Xlib Display* for
- * the display specified in the <option>--display</option> command
+ * the display specified in the `--display` command
  * line option or the `DISPLAY` environment variable.
  **/
 Display *
index c35635e0255a9c1842a4ea07d81b722ac15b80a7..d7eb201ea1a48dfceca085c1bebe576b31754239 100644 (file)
@@ -86,7 +86,7 @@
  * and `.gtkrc-3.0` in the users home directory.
  * (`SYSCONFDIR` defaults to
  * `/usr/local/etc`. It can be changed with the
- * <option>--prefix</option> or <option>--sysconfdir</option> options when
+ * `--prefix` or `--sysconfdir` options when
  * configuring GTK+.)
  *
  * The set of these <firstterm>default</firstterm> files
index fe19e42655614a7dc41b21a0f1274ac7cba4e543..9234782bbc478cd16a10e115173aa46cf24bf117 100644 (file)
@@ -840,19 +840,19 @@ gtk_get_option_group (gboolean open_default_display)
  *     <parameter>argv</parameter> parameter of main(), or %NULL. Any options
  *     understood by GTK+ are stripped before return.
  * @parameter_string: (allow-none): a string which is displayed in
- *    the first line of <option>--help</option> output, after
+ *    the first line of `--help` output, after
  *    <literal><replaceable>programname</replaceable> [OPTION...]</literal>
  * @entries: (array zero-terminated=1): a %NULL-terminated array
  *    of #GOptionEntrys describing the options of your program
  * @translation_domain: a translation domain to use for translating
- *    the <option>--help</option> output for the options in @entries
+ *    the `--help` output for the options in @entries
  *    and the @parameter_string with gettext(), or %NULL
  * @error: a return location for errors
  *
  * This function does the same work as gtk_init_check().
  * Additionally, it allows you to add your own commandline options,
  * and it automatically generates nicely formatted
- * <option>--help</option> output. Note that your program will
+ * `--help` output. Note that your program will
  * be terminated after writing out the help output.
  *
  * Returns: %TRUE if the windowing system has been successfully